home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Cream of the Crop 3
/
Cream of the Crop 3.iso
/
diag
/
itcom1.zip
/
COMPARE.EXE
/
IT
/
COMPARES.TXT
< prev
next >
Wrap
Text File
|
1993-10-29
|
19KB
|
459 lines
<<Introduction>>
IT Compares Introduction
════════════════════════
IT Compares is one of many modules in the ITs for Clarion
series of utilties. IT Compares has been created at the
request of Clarion Professional Developer (CPD) developers
and at the interest of Clarion Database Developer (CDD)
developers.
IT Compares' purpose is to support developers in maintaining
common file structures across applications and help
identify any differences. Developers of applications using
Clarion Professional Developer (CPD) must maintain the file
structures in each individual APP files. For systems where
multiple EXEs are implemented on a similar set of files,
this can become an increasingly difficult task as the
number of EXEs increases.
Since CPD does not support a central data dictionary, the
developer must either IMPORT file definitions from a master
APP (administratively controlled) or maintain the file
definitions through hand coding with or without the use
of INCLUDEs.
The majority of us have invested in the Clarion development
environment in an effort to increase our productivity; and
therefore, minimize the amount of hand coding and the amount
of required maintenance.
IT Compares prompts for the selection of two Clarion source
files. Each is validated as a Clarion PROGRAM file. Once
the files have been selected, the data declaration sections
are text parsed into an internal data structure. Three reports
are available on the internal data.
Report on the differences in files, keys,
indices, fields, groups, and memos on
file labels common to both files.
Report on file components identified in the
first file selected not present in the second
file selected.
Report on file components identified in the
second file selected not present in the first
file selected.
<<IT Compares Does and Does NOT>>
<IT Compares Does>
IT Compares Does
────────────────
Support FILE definitions in the GLOBAL scope.
Support FILE definitions in INCLUDEd files
called within the GLOBAL scope.
<IT Compares Does Not>
IT Compares Does Not
────────────────────
Support FILE definitions outside of the GLOBAL
scope. FILE definitions declared in the LOCAL
STATIC scope are not identified. This feature
is tagged for a future version release.
As of Clarion Database Developer batch release
3005, the EXTERNAL attribute use on a
file declaration is NOT supported in the current
release of IT Compares. This deficiency is due
to the timing of the 3005 batch release and this
release of IT Compares. This feature is tagged
for a future version release.
Search the PATH nor use the redirect (RED) file
for locating any files within the original
source files. This feature is tagged for a future
version release.
<<INI - Initialization File>>
ITCOMPAR.INI
────────────
Each of the ITs for Clarion utilizes a set of initialization
files (INIs) for selecting end-user modifiable parameters.
Each of the pertinent parameters is denoted and discussed
hereafter.
<INI - GRAPHIC=>
GRAPHIC=
Each of the ITs for Clarion operates in a text or graphic
environment. This INI parameter is essential in the
operation in graphic mode. Provided the value of the
GRAPHIC= parameter is ANY value other than YES {GRAPHIC=YES},
the utilty defaults to text mode. Text mode obviously runs
more quickly than graphic mode; therefore, if speed is of
utmost importance, then set this value to NO {GRAPHIC=NO}.
If the value is YES {GRAPHIC=YES}, the IT queries the
computer's video for the current mode. If the mode is EGA
or VGA, then the graphic parameters are activated immediately.
If the video mode is SVGA, then IT sets the video mode to
VGA then activates the graphic parameter internal to the
program.
<INI - CTLpath=>
CTLpath=
Each IT in the ITs for Clarion series utilizes a set of
control (CTL) files. These CTL files are used for controlling
the operation of each of the ITs. Normally, the CTL files are
placed in the \IT directory; however, they may be moved
to an alternate directory. Should you move the CTLs
to another directory, the value of this parameter must be
modified to include to new path.
The default is:
CTLpath=C:\IT
You might change it to:
CTLpath=C:\ITS\CTLS
<INI - DemoPath=>
DemoPath= │
│
Each IT in the ITs for Clarion has a DEMO. Our efforts │
to provide a completely functional DEMO include allowing │
the user to establish a customized demo path. │
<<Files Supplied>>
Supplied Files
──────────────
If you are like us, you want to know what files are supplied
and what is their purpose. We hope to provide a listing of
file extensions used and their purpose in the following
manner.
<Supplied Files>
<├─── EXEs Supplied>
*.EXE - Executables
Executable files are the program files purchased. Only EXEs
required are supplied with the ITs for Clarion series.
<├─── DLLs Supplied>
*.DLL - Dynamic Link Libraries
Dynamic Link Libraries are supplied as necessary to support
the operation of the ITs for Clarion. DLLs required
specifically for its operation are supplied on their unique
diskette or ZIP file, if accessed via the DTS ***BBS***.
DLLs supplied on a separate diskette are Clarion Database
Developer (CDD) supporting DLLs for the appropriate batch
release. Provided you are running with the same batch as the
IT was developed, these DLLs are not required. However, due
to the fact that some developers may choose to not upgrade
to the latest release of CDD and that others may upgrade
to CDD prior to the ITs for Clarion these DLLs are shipped
to provide compatibility.
<├─── HLPs Supplied>
*.HLP - Help Files │
│
Help files contains the MANY-MANY linkage for the Help IDs │
in the EXE to the help text (TXT) and the help screens. │
This file is required to be in the PATH for help to function. │
│
<├─── TXTs Supplied>
*.TXT - Help Text Files │
│
The Clarion Database Developer help system uses ASCII text │
files for the help system. Unless otherwise noted, │
Diversified Technology Solutions uses a consistant naming │
convention for these ASCII text files. The help text file │
inherits the filename of the associated executable with │
the TXT extension. For example, COMPARES.TXT is the ASCII │
help file for COMPARES.EXE. │
│
Notice that XTRACEs also contain the TXT extension and are │
not required for proper operation of the ITs for Clarion. │
<├─── INIs Supplied>
*.INI - Initialization Files
Initialization files are supplied with the ITs for Clarion
series providing end-user control of program parameters.
<├─── CTLs Supplied>
*.CTL - Control Files
Control files are supplied as an integral part of each ITs
for Clarion module controlling the operations of the utility.
As new features are included or modified, a simple
downloading of a new CTL may add addtional features to the
IT. All end-user modifiable parameters may be set within
the specific INI.
<└─── $$$s Created>
*.$$$ - Scratch Files
Scratch files are created by the memory management scheme of
the TopSpeed DOS extender. Additionally, the ITs
for Clarion utilities create scratch files for reporting and
supporting purposes. We have opted to use the $$$ extension
for these files to help you identify those files which may
be deleted without adverse affects. Should a system crash
occur during an ITs process, you may remove any of the
ITs scratch files without experiencing adverse affects.
Be careful to not delete any Clarion scratch files while
CDD is running.
<<Main Menu>>
IT Compares Main Menu
═════════════════════
<Files>
Files
─────
The FILES menu option provides a pulldown of two selections:
Select Files to Compare
Exit
<Reports>
Reports
───────
The REPORTS menu option supports the access to reports
available to the user. All REPORTS' menu selections are
dimmed until the SELECT FILES FOR COMPARE under the FILES
menu has been run in its fruition. Should the file
selection optoin be initiated then aborted, the REPORTS
options are again dimmed.
Three reports are available on the interal data:
<├─── Differences in Like Files>
Differences in Like Files
Report on the differences in files, keys,
indices, fields, groups, and memos on file
labels common to both files.
<├─── 1st File Labels NOT in 2nd>
1st File Labels NOT in 2nd
Report on file components identified in the
first file selected not present in the second
file selected.
<└─── 2nd File Labels NOT in 1st>
2nd File Labels NOT in 1st
Report on file components identified in the
second file selected not present in the first
file selected.
<About>
About
─────
The About menu selection displays a simple screen containing
general information regarding the product including but not
limited to the developer and version.
<Help>
Help
────
The Help menu selection retrieves a general help screen with
additional information pertaining to this IT.
<<Select Files for Comparison>>
Select Files for Comparison
═══════════════════════════
The user selects two valid Clarion PROGRAM files for
comparison of the FILE definitions. As each file is
selected it is checked to be a valid Clarion PROGRAM
file. If not, the process is aborted and control is
returned to the file selection screen.
<File Selection>
File Selection
──────────────
A standard set of screen fields are available in the file
selection screen. Each is described below.
<├─── File Mask>
File Mask
The File Mask field permits the input of a filter on the
file names available in the Files list box. The default
File mask is set to *.CLA to limit the display of Files
list box to a set of files containing the default Clarion
extension.
<├─── Directory >
Directory
The Directory field displays the currently selected
directory. As the path changes due to pertinent
selections from the Directories field, the currently
selected directory is displayed in this field.
<├─── Files>
Files
The Files field provides a listing of files available from
within the selected directory. The Files list box is
filtered by the entry in the File Mask field. The desired
file may be selected by cursor or mouse movement placing the
cursor bar on the desired entry followed by selection
of the OK button OR simply double-clicking the left mouse
button on the desired file.
<├─── Directories>
Directories
The Directories field provides a listing of directories.
The desired directory may be selected by cursor or mouse
movement placing the cursor bar on the desired entry
followed by selection of the OK button OR simply double-
clicking the left mouse button on the desired directory.
<├─── OK>
OK
Selecting the OK button completes the selection of file.
Once the file is selected, its contents are immediately
validated to be a Clarion PROGRAM file.
<└─── Cancel>
Cancel
Selecting the CANCEL button aborts the file selection
process and returns control to the main menu.
<File Processing>
Processing the Selected Files
─────────────────────────────
After each of the files have been selected and validated
for containing the appropriate scope, the contents of
each file are parsed into an internal supporting data set.
Once the data is available in a database format the
information is much more easily processed.
As each file is processed an appropriately titled list
box is displayed with the contents displayed as parsing
occurs. As each source file is parsed, INCLUDE files
located within the GLOBAL scope are added to the parsing
stack to support their parsing to ensure all FILE definitions
are indentified indeed.
<└─── Special NOTE on INCLUDEs>
NOTE: Any of the INCLUDE files MUST be explicitly denoted
inclusive of the path. If the complete path is NOT
specified within the INCLUDE file name, only the default
directory is searched. Neither the PATH nor RED are
used to locate INCLUDE files.
A field on the parsing screen immediately above the list
box displays the file currently parsed.
<Exit>
Exit
────
Selecting EXIT from the FILE menu performs minor clean-up
functions prior to returning control to the DOS environment.
All temporary files created by IT Compares are deleted from
the disk and the default directory is set to that from
which the program was initiated.
<<Report Redirection>>
Redirecting Report Output
═════════════════════════
After selecting a report for analysis, the standard CDD
template redirection screen is provided for directing the
report output to the desired device.
<Report Destination>
<├─── Destination>
Destination
A radio button selection is provided for redirection of
the report output. Devices are available as follows.
Parallel Ports
LPT1, LPT2, LPT3, and LPT4
Serial Ports
COM1, COM2, COM3, and COM4
Disk File
FILE
Screen Display
SCREEN
<├─── Filename>
Filename
If the FILE radio button is selected as the Destination
field, control is passed to the Filename field prompting
for the input of a disk file name.
<├─── OK>
OK
Selecting the OK button initiates the report generation with
output directed to the opted device.
<└─── Cancel>
Cancel
Selecting the CANCEL button aborts the report generation
and control is returned to the menu.
<<View Report>>
<Report Viewing>
View Report Output
══════════════════
After selecting a report for analysis, the standard CDD
template redirection screen is provided for directing the
report output to the desired device.
If the SCREEN or FILE is selected as the output device,
a list box is displayed permitting the viewing of the
report on screen. Three buttons are supplied: Print, Exit, │
and Help. │
<├─── Print>
Print
The output displayed on the screen may be printed by
pressing the Print button. Once PRINT is selected a set
of radio buttons is displayed beneath the list box for
selecting the device for output. Devices available are:
LPT1, LPT2, LPT3, LPT4, and
COM1, COM2.
<├─── Exit>
Exit
Exits the viewing port and returns control to the main menu.
< └─── Help>
Help │
│
Help relevant to this process is available by selecting │
this button. │